Compartilhar via


Manage orders - Gets a product promotion by id.

Obtém detalhes da promoção por ID.

GET https://api.partnercenter.microsoft.com/v{version}/productpromotions/{id}
GET https://api.partnercenter.microsoft.com/v{version}/productpromotions/{id}?country={country}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
id
path True

string

A ID da promoção.

version
path True

string

country
query

string

O código do país.

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
Authorization True

string

Token de portador de autorização

ms-correlationid

string

Usado para acompanhar solicitações internamente. Se um ms-correlationid não for fornecido, o servidor gerará um novo para cada solicitação

MS-CV

string

Usado para acompanhar solicitações internamente. Se um MS-CV não for fornecido, o servidor gerará um novo para cada solicitação

ms-requestid

string

Usado para idempotency de solicitações. Se uma ms-requestid não for fornecida, o servidor gerará uma nova para cada solicitação

Respostas

Nome Tipo Description
200 OK

Contracts.V1.Models.ProductPromotion

A solicitação foi bem-sucedida. O corpo da resposta conterá os detalhes da promoção.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

400 Bad Request

Havia uma entrada ausente ou inválida. O corpo da resposta fornecerá os detalhes do erro.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

401 Unauthorized

A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

403 Forbidden

A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

404 Not Found

O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

500 Internal Server Error

O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

Definições

Nome Description
Contracts.V1.Models.ProductPromotion
Contracts.V1.Models.ProductPromotionPricingPolicy
Contracts.V1.Models.ProductPromotionProperties
Contracts.V1.Models.ProductPromotionRequiredProduct
Contracts.V1.Models.ProductPromotionTerm

Contracts.V1.Models.ProductPromotion

Nome Tipo Description
description

string

endDate

string

id

string

name

string

properties

Contracts.V1.Models.ProductPromotionProperties

requiredProducts

Contracts.V1.Models.ProductPromotionRequiredProduct[]

startDate

string

Contracts.V1.Models.ProductPromotionPricingPolicy

Nome Tipo Description
policyType

string

value

string

Contracts.V1.Models.ProductPromotionProperties

Nome Tipo Description
isAutoApplicable

boolean

Contracts.V1.Models.ProductPromotionRequiredProduct

Nome Tipo Description
pricingPolicies

Contracts.V1.Models.ProductPromotionPricingPolicy[]

productId

string

skuId

string

term

Contracts.V1.Models.ProductPromotionTerm

Contracts.V1.Models.ProductPromotionTerm

Nome Tipo Description
billingCycle

string

duration

string